Eclipse Platform
Pre-release 3.0

org.eclipse.core.runtime.jobs
Class ProgressProvider

java.lang.Object
  extended byorg.eclipse.core.runtime.jobs.ProgressProvider

public abstract class ProgressProvider
extends Object

The progress provider supplies the job manager with progress monitors for running jobs. There can only be one progress provider at any given time.

This class is for internal use by the platform-related plug-ins. Clients outside of the base platform should not reference or subclass this class.

Since:
3.0
See Also:
IJobManager.setProgressProvider(org.eclipse.core.runtime.jobs.ProgressProvider)

Constructor Summary
ProgressProvider()
           
 
Method Summary
abstract  IProgressMonitor createMonitor(Job job)
          Provides a new progress monitor instance to be used by the given job.
 IProgressMonitor getDefaultMonitor()
          Returns a progress monitor to use when none has been provided by the client running the job.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProgressProvider

public ProgressProvider()
Method Detail

createMonitor

public abstract IProgressMonitor createMonitor(Job job)
Provides a new progress monitor instance to be used by the given job.

Parameters:
job - the job to create a progress monitor for
Returns:
a progress monitor, or null if no progress monitoring is needed.

getDefaultMonitor

public IProgressMonitor getDefaultMonitor()
Returns a progress monitor to use when none has been provided by the client running the job.

This default implementation returns a new NullProgressMonitor Subclasses may override.

Returns:
a progress monitor

Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.